Skip to content
This repository was archived by the owner on May 6, 2024. It is now read-only.

[SE-4481] Feature to upload edX service logs - #6418

Merged
jdmulloy merged 7 commits into
openedx-unsupported:masterfrom
open-craft:skchoudhary/se-4481-edx-services-log-sync
Jun 29, 2021
Merged

[SE-4481] Feature to upload edX service logs#6418
jdmulloy merged 7 commits into
openedx-unsupported:masterfrom
open-craft:skchoudhary/se-4481-edx-services-log-sync

Conversation

@Skchoudhary

@Skchoudhary Skchoudhary commented May 24, 2021

Copy link
Copy Markdown
Contributor

Description

This PR enables the syncing of the edx services logs to the s3 bucket if COMMON_OBJECT_STORE_LOG_EDX_SYNC set to true.

Supporting Information

JIRA Ticket: SE-4481

Testing instructions

TBD

Reviewers

@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. labels May 24, 2021
@openedx-webhooks

openedx-webhooks commented May 24, 2021

Copy link
Copy Markdown

Thanks for the pull request, @Skchoudhary! I've created OSPR-5797 to keep track of it in JIRA, where we prioritize reviews. Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

Comment thread playbooks/roles/common/templates/etc/logrotate.d/hourly/edx_logrotate.j2 Outdated
@natabene

Copy link
Copy Markdown
Contributor

@Skchoudhary Thank you for your contribution. Please let me know once it is ready for our review.

@natabene

natabene commented Jun 1, 2021

Copy link
Copy Markdown
Contributor

@Skchoudhary Please note that we cannot proceed with reviews for any of your PRs until we receive an answer from you to my email, sent on May 24. I will re-send it you right now, please check your spam folder and reply as soon as possible.

@Skchoudhary

Copy link
Copy Markdown
Contributor Author

Hi @natabene, I have replied to your email.

@natabene

natabene commented Jun 1, 2021

Copy link
Copy Markdown
Contributor

@Skchoudhary Thank you, you are all set now.

Comment thread playbooks/roles/common_vars/defaults/main.yml Outdated
Comment thread playbooks/roles/common/templates/etc/logrotate.d/hourly/edx_logrotate.j2 Outdated
Comment thread playbooks/retire_host.yml
Comment thread playbooks/retire_host.yml
@Skchoudhary
Skchoudhary marked this pull request as ready for review June 7, 2021 11:33
@Skchoudhary Skchoudhary changed the title WIP [SE-4481] Feature to upload edX service logs [SE-4481] Feature to upload edX service logs Jun 7, 2021
@openedx-webhooks openedx-webhooks added needs triage waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. and removed waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. needs triage labels Jun 7, 2021

@pkulkark pkulkark left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Skchoudhary LGTM 👍

  • I tested this: verified that the edx service logs are uploaded when the feature is enabled.
  • I read through the code.
  • I checked for accessibility N/A
  • Includes documentation N/A

@Skchoudhary

Copy link
Copy Markdown
Contributor Author

Hi @natabene
This PR is ready for edX's review

@openedx-webhooks openedx-webhooks added awaiting prioritization and removed waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. labels Jun 15, 2021
@jdmulloy
jdmulloy merged commit 8562f4d into openedx-unsupported:master Jun 29, 2021
@openedx-webhooks

Copy link
Copy Markdown

@Skchoudhary 🎉 Your pull request was merged!

Please take a moment to answer a two question survey so we can improve your experience in the future.

@jdmulloy

Copy link
Copy Markdown
Contributor

@Skchoudhary unfortunately we had to revert this PR because it broke log upload and instance shutdown on the edx.org infrastructure. We'll need to figure out how to preserve the old behavior for edx.org while allowing the behavior you need. Probably need to use boolean flags.

@jdmulloy

Copy link
Copy Markdown
Contributor

@Skchoudhary It looks like the error we got was "msg": "'COMMON_OBJECT_STORE_LOG_SYNC_PREFIX' is undefined". So I think you need to make sure there's a sensible default for this variable. Also I think we just want to sync tracking logs, and not the lms and cms logs, because we only sync those via Splunk and don't need to sync them via Splunk, so we need syncing of those logs to be optional.

@Skchoudhary

Skchoudhary commented Jul 1, 2021

Copy link
Copy Markdown
Contributor Author

@jdmulloy Thanks for pointing that out, will only sync the tracking logs for now.

@Skchoudhary

Copy link
Copy Markdown
Contributor Author

Hi @pkulkark,

Can you please have look into the issue as me might have to update the other PR also? If I got time this weekend, I can check this If you want.

@pkulkark

pkulkark commented Jul 1, 2021

Copy link
Copy Markdown
Contributor

No problem @Skchoudhary I'll take care of it.

@pkulkark

pkulkark commented Jul 1, 2021

Copy link
Copy Markdown
Contributor

@jdmulloy I opened a new PR #6465 that re-introduces the option to sync edx-services logs but only when the COMMON_OBJECT_STORE_EDX_LOG_SYNC flag is set to true. Could you review it?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

open-source-contribution PR author is not from Axim or 2U rejected

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants